3 use Wikimedia\Rdbms\LBFactorySimple
;
4 use Wikimedia\Rdbms\LBFactoryMulti
;
5 use Wikimedia\Rdbms\ChronologyProtector
;
8 * Holds tests for LBFactory abstract MediaWiki class.
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
27 * @author Antoine Musso
28 * @copyright © 2013 Antoine Musso
29 * @copyright © 2013 Wikimedia Foundation Inc.
31 class LBFactoryTest
extends MediaWikiTestCase
{
34 * @dataProvider getLBFactoryClassProvider
36 public function testGetLBFactoryClass( $expected, $deprecated ) {
37 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
38 ->disableOriginalConstructor()
42 'class' => $deprecated,
43 'connection' => $mockDB,
44 # Various other parameters required:
47 'serverTemplate' => [],
50 $this->hideDeprecated( '$wgLBFactoryConf must be updated. See RELEASE-NOTES for details' );
51 $result = MWLBFactory
::getLBFactoryClass( $config );
53 $this->assertEquals( $expected, $result );
56 public function getLBFactoryClassProvider() {
58 # Format: new class, old class
59 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactory_Simple' ],
60 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactory_Single' ],
61 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactory_Multi' ],
62 [ Wikimedia\Rdbms\LBFactorySimple
::class, 'LBFactorySimple' ],
63 [ Wikimedia\Rdbms\LBFactorySingle
::class, 'LBFactorySingle' ],
64 [ Wikimedia\Rdbms\LBFactoryMulti
::class, 'LBFactoryMulti' ],
68 public function testLBFactorySimpleServer() {
69 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
73 'host' => $wgDBserver,
74 'dbname' => $wgDBname,
76 'password' => $wgDBpassword,
78 'dbDirectory' => $wgSQLiteDataDir,
80 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
84 $factory = new LBFactorySimple( [ 'servers' => $servers ] );
85 $lb = $factory->getMainLB();
87 $dbw = $lb->getConnection( DB_MASTER
);
88 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
90 $dbr = $lb->getConnection( DB_SLAVE
);
91 $this->assertTrue( $dbr->getLBInfo( 'master' ), 'DB_SLAVE also gets the master' );
97 public function testLBFactorySimpleServers() {
98 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
102 'host' => $wgDBserver,
103 'dbname' => $wgDBname,
105 'password' => $wgDBpassword,
107 'dbDirectory' => $wgSQLiteDataDir,
109 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
112 'host' => $wgDBserver,
113 'dbname' => $wgDBname,
115 'password' => $wgDBpassword,
117 'dbDirectory' => $wgSQLiteDataDir,
119 'flags' => DBO_TRX
// REPEATABLE-READ for consistency
123 $factory = new LBFactorySimple( [
124 'servers' => $servers,
125 'loadMonitorClass' => 'LoadMonitorNull'
127 $lb = $factory->getMainLB();
129 $dbw = $lb->getConnection( DB_MASTER
);
130 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
132 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
133 $dbw->getLBInfo( 'clusterMasterHost' ),
134 'cluster master set' );
136 $dbr = $lb->getConnection( DB_SLAVE
);
137 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
139 ( $wgDBserver != '' ) ?
$wgDBserver : 'localhost',
140 $dbr->getLBInfo( 'clusterMasterHost' ),
141 'cluster master set' );
143 $factory->shutdown();
147 public function testLBFactoryMulti() {
148 global $wgDBserver, $wgDBname, $wgDBuser, $wgDBpassword, $wgDBtype, $wgSQLiteDataDir;
150 $factory = new LBFactoryMulti( [
151 'sectionsByDB' => [],
158 'serverTemplate' => [
159 'dbname' => $wgDBname,
161 'password' => $wgDBpassword,
163 'dbDirectory' => $wgSQLiteDataDir,
164 'flags' => DBO_DEFAULT
167 'test-db1' => $wgDBserver,
168 'test-db2' => $wgDBserver
170 'loadMonitorClass' => 'LoadMonitorNull'
172 $lb = $factory->getMainLB();
174 $dbw = $lb->getConnection( DB_MASTER
);
175 $this->assertTrue( $dbw->getLBInfo( 'master' ), 'master shows as master' );
177 $dbr = $lb->getConnection( DB_SLAVE
);
178 $this->assertTrue( $dbr->getLBInfo( 'replica' ), 'slave shows as slave' );
180 $factory->shutdown();
184 public function testChronologyProtector() {
185 // (a) First HTTP request
186 $mPos = new MySQLMasterPos( 'db1034-bin.000976', '843431247' );
188 $now = microtime( true );
189 $mockDB = $this->getMockBuilder( 'DatabaseMysqli' )
190 ->disableOriginalConstructor()
192 $mockDB->method( 'writesOrCallbacksPending' )->willReturn( true );
193 $mockDB->method( 'lastDoneWrites' )->willReturn( $now );
194 $mockDB->method( 'getMasterPos' )->willReturn( $mPos );
196 $lb = $this->getMockBuilder( 'LoadBalancer' )
197 ->disableOriginalConstructor()
199 $lb->method( 'getConnection' )->willReturn( $mockDB );
200 $lb->method( 'getServerCount' )->willReturn( 2 );
201 $lb->method( 'parentInfo' )->willReturn( [ 'id' => "main-DEFAULT" ] );
202 $lb->method( 'getAnyOpenConnection' )->willReturn( $mockDB );
203 $lb->method( 'hasOrMadeRecentMasterChanges' )->will( $this->returnCallback(
204 function () use ( $mockDB ) {
206 $p |
= call_user_func( [ $mockDB, 'writesOrCallbacksPending' ] );
207 $p |
= call_user_func( [ $mockDB, 'lastDoneWrites' ] );
212 $lb->method( 'getMasterPos' )->willReturn( $mPos );
214 $bag = new HashBagOStuff();
215 $cp = new ChronologyProtector(
219 'agent' => "Totally-Not-FireFox"
223 $mockDB->expects( $this->exactly( 2 ) )->method( 'writesOrCallbacksPending' );
224 $mockDB->expects( $this->exactly( 2 ) )->method( 'lastDoneWrites' );
226 // Nothing to wait for
229 $cp->shutdownLB( $lb );
232 // (b) Second HTTP request
233 $cp = new ChronologyProtector(
237 'agent' => "Totally-Not-FireFox"
241 $lb->expects( $this->once() )
242 ->method( 'waitFor' )->with( $this->equalTo( $mPos ) );
247 $cp->shutdownLB( $lb );
251 private function newLBFactoryMulti( array $baseOverride = [], array $serverOverride = [] ) {
252 global $wgDBserver, $wgDBuser, $wgDBpassword, $wgDBname, $wgDBtype, $wgSQLiteDataDir;
254 return new LBFactoryMulti( $baseOverride +
[
255 'sectionsByDB' => [],
261 'serverTemplate' => $serverOverride +
[
262 'dbname' => $wgDBname,
264 'password' => $wgDBpassword,
266 'dbDirectory' => $wgSQLiteDataDir,
267 'flags' => DBO_DEFAULT
270 'test-db1' => $wgDBserver,
272 'loadMonitorClass' => 'LoadMonitorNull',
273 'localDomain' => wfWikiID()
277 public function testNiceDomains() {
278 global $wgDBname, $wgDBtype;
280 if ( $wgDBtype === 'sqlite' ) {
281 $tmpDir = $this->getNewTempDirectory();
282 $dbPath = "$tmpDir/unit_test_db.sqlite";
283 file_put_contents( $dbPath, '' );
284 $tempFsFile = new TempFSFile( $dbPath );
285 $tempFsFile->autocollect();
290 $factory = $this->newLBFactoryMulti(
292 [ 'dbFilePath' => $dbPath ]
294 $lb = $factory->getMainLB();
296 if ( $wgDBtype !== 'sqlite' ) {
297 $db = $lb->getConnectionRef( DB_MASTER
);
305 /** @var Database $db */
306 $db = $lb->getConnection( DB_MASTER
, [], '' );
307 $lb->reuseConnection( $db ); // don't care
315 $this->quoteTable( $db, 'page' ),
316 $db->tableName( 'page' ),
317 "Correct full table name"
321 $this->quoteTable( $db, $wgDBname ) . '.' . $this->quoteTable( $db, 'page' ),
322 $db->tableName( "$wgDBname.page" ),
323 "Correct full table name"
327 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
328 $db->tableName( 'nice_db.page' ),
329 "Correct full table name"
332 $factory->setDomainPrefix( 'my_' );
338 $this->quoteTable( $db, 'my_page' ),
339 $db->tableName( 'page' ),
340 "Correct full table name"
343 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
344 $db->tableName( 'other_nice_db.page' ),
345 "Correct full table name"
348 $factory->closeAll();
352 public function testTrickyDomain() {
355 if ( $wgDBtype === 'sqlite' ) {
356 $tmpDir = $this->getNewTempDirectory();
357 $dbPath = "$tmpDir/unit_test_db.sqlite";
358 file_put_contents( $dbPath, '' );
359 $tempFsFile = new TempFSFile( $dbPath );
360 $tempFsFile->autocollect();
365 $dbname = 'unittest-domain';
366 $factory = $this->newLBFactoryMulti(
367 [ 'localDomain' => $dbname ],
368 [ 'dbname' => $dbname, 'dbFilePath' => $dbPath ]
370 $lb = $factory->getMainLB();
371 /** @var Database $db */
372 $db = $lb->getConnection( DB_MASTER
, [], '' );
373 $lb->reuseConnection( $db ); // don't care
381 $this->quoteTable( $db, 'page' ),
382 $db->tableName( 'page' ),
383 "Correct full table name"
387 $this->quoteTable( $db, $dbname ) . '.' . $this->quoteTable( $db, 'page' ),
388 $db->tableName( "$dbname.page" ),
389 "Correct full table name"
393 $this->quoteTable( $db, 'nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
394 $db->tableName( 'nice_db.page' ),
395 "Correct full table name"
398 $factory->setDomainPrefix( 'my_' );
401 $this->quoteTable( $db, 'my_page' ),
402 $db->tableName( 'page' ),
403 "Correct full table name"
406 $this->quoteTable( $db, 'other_nice_db' ) . '.' . $this->quoteTable( $db, 'page' ),
407 $db->tableName( 'other_nice_db.page' ),
408 "Correct full table name"
411 \MediaWiki\
suppressWarnings();
412 $this->assertFalse( $db->selectDB( 'garbage-db' ) );
413 \MediaWiki\restoreWarnings
();
416 $this->quoteTable( $db, 'garbage-db' ) . '.' . $this->quoteTable( $db, 'page' ),
417 $db->tableName( 'garbage-db.page' ),
418 "Correct full table name"
421 $factory->closeAll();
425 private function quoteTable( Database
$db, $table ) {
426 if ( $db->getType() === 'sqlite' ) {
429 return $db->addIdentifierQuotes( $table );